Mappedin Android SDK/com.mappedin.sdk/MPIMapViewInterface

MPIMapViewInterface

interface MPIMapViewInterface
Content copied to clipboard

This class contains methods that help to display and interact with a Mappedin venue

Functions

Link copied to clipboard
abstract fun addInteractivePolygon(polygon: MPINavigatable.MPIPolygon)
Content copied to clipboard
abstract fun addInteractivePolygon(polygonId: String)
Content copied to clipboard

Adds an interactive polygon (allows it to be clickable)

Link copied to clipboard
abstract suspend fun clearAllPolygonColors()
Content copied to clipboard
abstract fun clearAllPolygonColors(completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Clears color on all polygons

Link copied to clipboard
abstract fun createMarker(    coordinate: MPIMap.MPICoordinate,     contentHtml: String,     markerOptions: MPIOptions.Marker = MPIOptions.Marker()): String
Content copied to clipboard

Creates a marker on a MPINavigatable.MPICoordinate

abstract fun createMarker(    node: MPINavigatable.MPINode,     contentHtml: String,     markerOptions: MPIOptions.Marker = MPIOptions.Marker()): String
Content copied to clipboard

Creates a marker on a MPINavigatable.MPINode

Link copied to clipboard
abstract fun drawPath(path: List<MPINavigatable.MPINode>, pathOptions: MPIOptions.Path? = null)
Content copied to clipboard

Draws a path on the MPIMapView

Link copied to clipboard
abstract fun enableImageFlippingForPolygon(polygon: MPINavigatable.MPIPolygon)
Content copied to clipboard

Enables image flipping for a polygon

Link copied to clipboard
abstract suspend fun getDirections(    to: MPIDestinationSet,     from: MPINavigatable,     accessible: Boolean = true): List<MPIDirections>
Content copied to clipboard
abstract fun getDirections(    to: MPIDestinationSet,     from: MPINavigatable,     accessible: Boolean = true,     directionsCallback: (List<MPIDirections>?) -> Unit)
Content copied to clipboard

Get directions to a MPIDestinationSet (MPINavigatable.MPINode, MPINavigatable.MPILocation, MPINavigatable.MPIPolygon) from another MPINavigatable

abstract suspend fun getDirections(    to: MPINavigatable,     from: MPINavigatable,     accessible: Boolean = true): MPIDirections
Content copied to clipboard
abstract fun getDirections(    to: MPINavigatable,     from: MPINavigatable,     accessible: Boolean = true,     directionsCallback: (MPIDirections?) -> Unit)
Content copied to clipboard

Get directions to a MPINavigatable (MPINavigatable.MPINode, MPINavigatable.MPILocation, MPINavigatable.MPIPolygon) from another MPINavigatable

Link copied to clipboard
abstract suspend fun getNearestNodeByScreenCoordinates(    x: Int,     y: Int,     map: MPIMap? = null): MPINavigatable.MPINode
Content copied to clipboard
abstract fun getNearestNodeByScreenCoordinates(    x: Int,     y: Int,     map: MPIMap? = null,     nearestNodeCallback: (MPINavigatable.MPINode?) -> Unit)
Content copied to clipboard

Gets the nearest node by screen coordinates

Link copied to clipboard
abstract fun getPolygonsAtCoordinate(    coord: MPIMap.MPICoordinate,     options: MPIOptions.GetPolygonsAtCoordinate? = null,     polygonsCallback: (List<MPINavigatable.MPIPolygon>?) -> Unit)
Content copied to clipboard

Gets a list of polygons by screen coordinates

Link copied to clipboard
abstract fun labelAllLocations(options: MPIOptions.FlatLabelAllLocations? = null)
Content copied to clipboard
abstract fun labelAllLocations(options: MPIOptions.FloatingLabelAllLocations? = null)
Content copied to clipboard

Label all polygons with locations either loaded via the API or passed in

Link copied to clipboard
abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FlatLabel)
Content copied to clipboard
abstract fun labelPolygon(polygonId: String, options: MPIOptions.FlatLabel)
Content copied to clipboard

Sets a flat label for MPINavigatable.MPIPolygon

abstract fun labelPolygon(polygon: MPINavigatable.MPIPolygon, options: MPIOptions.FloatingLabel)
Content copied to clipboard
abstract fun labelPolygon(polygonId: String, options: MPIOptions.FloatingLabel)
Content copied to clipboard

Sets a floating label for MPINavigatable.MPIPolygon

Link copied to clipboard
abstract fun loadVenue(    options: MPIOptions.Init,     showVenueOptions: MPIOptions.ShowVenue? = null,     errorCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Loads the venue based on the options passed in MPIMapView

Link copied to clipboard
abstract suspend fun removeAllPaths()
Content copied to clipboard
abstract fun removeAllPaths(completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Remove all paths on the MPIMapView

Link copied to clipboard
abstract fun removeMarker(markerId: String)
Content copied to clipboard

Removes a marker from a MPINavigatable.MPINode

Link copied to clipboard
abstract suspend fun setMap(map: MPIMap)
Content copied to clipboard
abstract suspend fun setMap(mapId: String)
Content copied to clipboard
abstract fun setMap(map: MPIMap, completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard
abstract fun setMap(mapId: String, completionCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Sets the MPIMap of the MPIMapView

Link copied to clipboard
abstract fun setPolygonColor(polygon: MPINavigatable.MPIPolygon, color: String)
Content copied to clipboard

Sets the color of the MPINavigatable.MPIPolygon

Link copied to clipboard
abstract fun showVenue(    venueResponse: MPIVenueResponse,     showVenueOptions: MPIOptions.ShowVenue? = null,     errorCallback: (MPIError?) -> Unit?)
Content copied to clipboard
abstract fun showVenue(    venueResponse: String,     showVenueOptions: MPIOptions.ShowVenue? = null,     errorCallback: (MPIError?) -> Unit?)
Content copied to clipboard

Shows the venue based on the venue data and options passed in MPIMapView

Inheritors

Link copied to clipboard